Skip to main content
GET
/
v1
/
prompt-partials
Get Prompt Partials
curl --request GET \
  --url https://api.getmaxim.ai/v1/prompt-partials \
  --header 'x-maxim-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "workspaceId": "<string>",
      "accountId": "<string>",
      "folderId": "<string>",
      "createdById": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>"
    }
  ],
  "pagination": {
    "hasMore": true,
    "cursor": "<string>"
  }
}

Authorizations

x-maxim-api-key
string
header
required

API key for authentication

Query Parameters

workspaceId
string
required

Unique identifier for the workspace

id
string

Unique identifier for the prompt partial

name
string

Name of the prompt partial

limit
number | null
default:10

Maximum number of records to return (max: 100)

Required range: x <= 100
folderId
string

Unique identifier for the folder

includeVersions
boolean | null
default:false

Include prompt partial versions in the response

cursor
string

Unique identifier for the cursor

Response

Prompt partials retrieved successfully

data
object[]
required
pagination
object
required